Rearrange into logical sections and add relevant links #9639
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| - When writing tests, use 2.6 compatible `self.assertFoo` methods. Some polyfills such as `assertRaises` | ||
| can be found in `pandas.util.testing`. | ||
| - Do not attach doctrings to tests. Make the test itself readable and use comments if needed. | ||
| - **Make sure the test suite passes** on your box, use the provided `test_*.sh` scripts or tox. Pandas tests a variety of platforms and Python versions so be cognizant of cross-platorm considerations. |
There was a problem hiding this comment.
We should probably mention Travis-CI here, and the ease of setting up Travis on your own fork.
|
This looks like a nice improvement! Merging... |
shoyer
added a commit
that referenced
this pull request
Mar 13, 2015
Rearrange into logical sections and add relevant links
| - Optionally, a commit message body. | ||
| - Please reference relevant Github issues in your commit message using `GH1234` | ||
| or `#1234`. Either style is fine but the '#' style generates noise when your rebase your PR. | ||
| - `doc/source/vx.y.z.txt` contains an ongoing |
There was a problem hiding this comment.
This is now doc/source/whatsnew/vx.y.z.txt
|
@rockg Thanks a lot for this! Just a comment about the numpydoc reference, but maybe I missed it. |
|
It is at the top of the "Documentation / Commit Messages" section (I felt it was important). |
|
Ah, so I missed it! :-) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This rearranges the Contributing page into more logical sections and provides some more useful links to wiki pages. I think this should be the place where all relevant documentation on pandas development can be found. For example, both this page and the pandas homepage mention
vbenchbut the information on running tests was lacking and it turns out that the wiki has this information but it was difficult to find. Hopefully this is a step in the right direction.